Skip to content

Fix OAuth example to avoid unsupported custom basepath#5901

Open
compair-steven wants to merge 1 commit into
mintlify:mainfrom
compair-steven:fix-auth-oauth-basepath-example
Open

Fix OAuth example to avoid unsupported custom basepath#5901
compair-steven wants to merge 1 commit into
mintlify:mainfrom
compair-steven:fix-auth-oauth-basepath-example

Conversation

@compair-steven
Copy link
Copy Markdown

@compair-steven compair-steven commented May 22, 2026

Summary

This PR is intended to update the OAuth 2.0 examples in the auth setup docs to avoid using a custom basepath as the hosted documentation URL, which was explicitly addressed in PR #4387.

Because of the previous PR, the page states that auth is not supported when using a custom basepath such as example.com/docs, but the OAuth example currently uses foo.com/docs as the docs URL. This could make the OAuth setup appear supported for deployment in a way that the same page says is unsupported.

Documentation Changes

  • Changed the OAuth example docs host from foo.com/docs to docs.foo.com
  • Updated the corresponding encoded returnTo value in the Logout URL
  • Applied the same fix to the English, Chinese, Spanish, and French auth setup pages

Notes

This is a documentation-only consistency fix. I left the api.foo.com/docs/user-info example unchanged because that appears to be an application/API endpoint path, not the hosted Mintlify docs path.


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Low risk documentation-only edits; changes are limited to example URLs and minor formatting/newline fixes.

Overview
Aligns the OAuth 2.0 example in authentication-setup.mdx (EN/ES/FR/ZH) with the documented restriction that authentication is not supported on custom basepaths by switching the sample docs URL from foo.com/docs to docs.foo.com.

Updates the example Logout URL returnTo value accordingly, and normalizes the final table row/newline at EOF in translated pages.

Reviewed by Cursor Bugbot for commit 1293fb8. Bugbot is set up for automated code reviews on this repo. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant